Skip to content

sass: Use @wordpress/base-styles as a module #43607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2025

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented May 23, 2025

Proposed changes:

Sass has deprecated @import in favor of @use. In this PR, we convert uses of the @wordpress/base-styles to @use.

Since @automattic/jetpack-base-styles/gutenberg-base-styles just re-exports @wordpress/base-styles, this PR converts that as well.

There are two places where we had to leave @imports due to other @wordpress/* packages assuming that @wordpress/base-styles will have been imported rather than used. These both have comments indicating that they should be cleaned up once it's possible to do so.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None linkable

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Check that stuff still works right.
    • Since the only change to built css seems to be fixing some places in Jetpack-the-plugin's _inc/build/admin.css where the z-index() function wasn't being included previously (so the output CSS had a bogus function call), we're probably good.

Sass has deprecated `@import` in favor of `@use`. In this PR, we convert
uses of the `@wordpress/base-styles` to `@use`.

Since `@automattic/jetpack-base-styles/gutenberg-base-styles` just
re-exports `@wordpress/base-styles`, this PR converts that as well.

There are two places where we had to leave `@import`s due to other
`@wordpress/*` packages assuming that `@wordpress/base-styles` will have
been imported rather than used. These both have comments indicating that
they should be cleaned up once it's possible to do so.
@anomiex anomiex requested a review from a team May 23, 2025 21:15
@anomiex anomiex self-assigned this May 23, 2025
Copy link
Contributor

github-actions bot commented May 23, 2025

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack or WordPress.com Site Helper), and enable the update/sass-wordpress-base-styles-as-modules branch.
  • To test on Simple, run the following command on your sandbox:
bin/jetpack-downloader test jetpack update/sass-wordpress-base-styles-as-modules
bin/jetpack-downloader test jetpack-mu-wpcom-plugin update/sass-wordpress-base-styles-as-modules

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

Copy link
Contributor

github-actions bot commented May 23, 2025

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
  3. You can use GitHub's Reviewers functionality to request a review.
  4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!


Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen as soon as you deploy your changes after merging this PR (PCYsg-Jjm-p2).
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly:
    • Scheduled release: June 3, 2025
    • Code freeze: June 2, 2025

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Copy link

jp-launch-control bot commented May 23, 2025

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

tbradsha
tbradsha previously approved these changes May 26, 2025
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for handling this!

@anomiex anomiex merged commit d72a289 into trunk May 27, 2025
84 checks passed
@anomiex anomiex deleted the update/sass-wordpress-base-styles-as-modules branch May 27, 2025 18:03
@github-actions github-actions bot removed the [Status] Needs Review This PR is ready for review. label May 27, 2025
@simison simison mentioned this pull request May 28, 2025
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Admin Page React-powered dashboard under the Jetpack menu [Block] Ad [Block] Blogging Prompt [Block] Blogroll [Block] Business Hours [Block] Contact Form Form block (also see Contact Form label) [Block] Donations [Block] GIF [Block] Google Docs Embed [Block] Latest Instagram Posts [Block] Mailchimp [Block] Map [Block] Markdown [Block] OpenTable [Block] Paid Content aka Premium Content [Block] Pay With Paypal aka Simple Payments [Block] Payments Intro [Block] Payments aka Unified Intro [Block] Paywall [Block] Podcast Player [Block] Related Posts [Block] Repeat Visitor [Block] Sharing Button [Block] Slideshow [Block] Star Rating [Block] Story [Block] Tiled Gallery [Block] Top Posts [Block] VideoPress Docs [Extension] SEO [Extension] Social Previews Social Preview block editor plugin [Feature] Contact Form [Feature] Publicize Now Jetpack Social, auto-sharing [Feature] Subscriptions All subscription-related things such as paid and unpaid, user management, and newsletter settings. [JS Package] AI Client [JS Package] Base Styles [JS Package] Components [JS Package] Connection [JS Package] IDC [JS Package] Partner Coupon [JS Package] Publicize Components [JS Package] Shared Extension Utils [JS Package] Storybook [mu wpcom Feature] Wpcom Admin Bar [mu wpcom Feature] Wpcom Block Editor Nux [mu wpcom Feature] Wpcom Blocks [mu wpcom Feature] Wpcom Global Styles [Package] Ad aka WordAds [Package] External Media [Package] Forms [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] VideoPress [Plugin] CRM Issues about the Jetpack CRM plugin [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal RNA [Type] Janitorial
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants